Api.WriteAxisMaxCurrent method

Writes the maximum current into an axis.

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsError WriteAxisMaxCurrent(
       int Index,
       short Value
)

Public Function WriteAxisMaxCurrent(
       Index As Integer,
       Value As Short
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Value

Type: short

The value to write.

Return value

A return code of a method.

Remarks

Used in the cyclic callback to update the maximum current of an axis.

NOTE: The maximum current is available only if EnableMaxCurrent is enabled.

Usable EtherCAT states

ecatOP

Examples

N/A